home *** CD-ROM | disk | FTP | other *** search
/ PC Pro 2005 June (DVD) / DPPRO0605DVD.iso / Install / program files / Borland / BDS / 3.0 / Help / Common / ConfigFile.xsd < prev    next >
Encoding:
Extensible Markup Language  |  2004-10-22  |  15.9 KB  |  289 lines

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">
  3.     <xs:element name="helpConfig">
  4.         <xs:annotation>
  5.             <xs:documentation>A set of parameters specifiying an addition to the Borland help system.</xs:documentation>
  6.         </xs:annotation>
  7.         <xs:complexType>
  8.             <xs:sequence>
  9.                 <xs:element name="InstallDirectory" type="xs:string">
  10.                     <xs:annotation>
  11.                         <xs:documentation>Either a fully-qualified path name or a registry value that points to the location in which your Help files should be installed. To copy your files to the BDS "ThirdParty" folder, use "bdsdocs" as your InstallDest and prepend each file name in your file list with the path "\Help\ThirdParty\" (only).</xs:documentation>
  12.                     </xs:annotation>
  13.                 </xs:element>
  14.                 <xs:element name="ParentNamespace" type="xs:string">
  15.                     <xs:annotation>
  16.                         <xs:documentation>Parent namespace that the files will be installed under.  Should always be "borland.bds".</xs:documentation>
  17.                     </xs:annotation>
  18.                 </xs:element>
  19.                 <xs:element name="LangID" type="xs:integer" minOccurs="0">
  20.                     <xs:annotation>
  21.                         <xs:documentation>4 digit number indicating the language of the source files.  Only required if internationalizing.</xs:documentation>
  22.                     </xs:annotation>
  23.                 </xs:element>
  24.                 <xs:element name="Versioning" minOccurs="0">
  25.                     <xs:annotation>
  26.                         <xs:documentation>Used only when you want to install a new file set over an old set. Recognized values: "none" (default) means replace installed files with update files of the same names, regardless of version numbers or date/time stamps; "date" copies only newer files; "file" instructs the script to compare file versions on the old and new files, and replace only those that show older version numbers. Another recognized option--used by the Borland documentation set-- is "extended." This value instructs the script to parse a four-segment numeric version stamp (delimited by periods), with the first two segments representing a file's major and minor version numbers, the third segment representing a StockKeeping Unit (SKU; e.g., Enterprise, Professional, Personal editions of a product), and the final segment representing a localized build (LCID number). A typical "extended" version number might be "1.1034.2.1031", which, in your scheme, might mean version 1, build 1034, the second of three SKUs, and a German file set. When file updates are compared to installed files, users are warned if the SKU or LCID numbers do not match. If the user decides to proceed anyway, all installed files are replaced with files of the same names from the update set. If the SKUs and LCID numbers match (and the question is not posed), then the file version numbers (first two segments of the string) are compared, and all files with older version numbers are replaced. If this key is absent or values other than those shown here are used, version comparisons are not performed.</xs:documentation>
  27.                     </xs:annotation>
  28.                     <xs:simpleType>
  29.                         <xs:restriction base="xs:string">
  30.                             <xs:enumeration value="none"/>
  31.                             <xs:enumeration value="date"/>
  32.                             <xs:enumeration value="file"/>
  33.                             <xs:enumeration value="extended"/>
  34.                         </xs:restriction>
  35.                     </xs:simpleType>
  36.                 </xs:element>
  37.                 <xs:element name="InstallSrc" type="xs:string">
  38.                     <xs:annotation>
  39.                         <xs:documentation>Specifies the location of your Help files on your installation media or local folder, relative to the location of the regHelp.js script. An asterisk (*) appended to the path means your files are all in the same source folder. If the asterisk is not present, the script adds any path specs from the file list to the InstallSrc path spec when attempting to install files.</xs:documentation>
  40.                     </xs:annotation>
  41.                 </xs:element>
  42.                 <xs:element name="BdsRoot" type="xs:string" minOccurs="0">
  43.                     <xs:annotation>
  44.                         <xs:documentation>Root directory for BDS installation. </xs:documentation>
  45.                     </xs:annotation>
  46.                 </xs:element>
  47.                 <xs:element name="SdkRoot" type="xs:string" minOccurs="0">
  48.                     <xs:annotation>
  49.                         <xs:documentation>Root directory for .NET Framework installation.</xs:documentation>
  50.                     </xs:annotation>
  51.                 </xs:element>
  52.                 <xs:element name="ShortCut" minOccurs="0">
  53.                     <xs:simpleType>
  54.                         <xs:restriction base="xs:string">
  55.                             <xs:pattern value=".+\.[Ll][Nn][Kk]"/>
  56.                         </xs:restriction>
  57.                     </xs:simpleType>
  58.                 </xs:element>
  59.                 <xs:choice>
  60.                     <xs:element name="Merge">
  61.                         <xs:annotation>
  62.                             <xs:documentation>Contains information needed to merge a set of documentation files with the existing Borland TOC and documentation set.</xs:documentation>
  63.                         </xs:annotation>
  64.                         <xs:complexType>
  65.                             <xs:sequence>
  66.                                 <xs:element name="TOCTitle" minOccurs="0">
  67.                                     <xs:annotation>
  68.                                         <xs:documentation>Your table of contents heading, used in a rewrite of the parent BDS Table of Contents (bds.HxT) file. If you don't want your table of contents merged with bds.HxT, you can leave this line (and MergeTOCurl) out. Note: If refreshing or reregistering an installed file set, the script checks for this value in the existing bds.HxT. If it finds it, it skips the .HxT rewrite. Thus, if adding new files to an existing installation, or if you change contents information, you should first unregister (to remove existing contents information), then reregister your file set to update the contents with your new information.</xs:documentation>
  69.                                     </xs:annotation>
  70.                                 </xs:element>
  71.                                 <xs:element name="TOCUrl" minOccurs="0">
  72.                                     <xs:annotation>
  73.                                         <xs:documentation>Used only if a MergeTOCtitle is specified. If merging your table of contents, this fully-qualified URL points to an introductory topic contained in one of your Help files. The URL must match the URL you would see in the Address field of the Document Explorer Help viewer when viewing your introductory topic, with the namespace portion replaced by "borland.bds".</xs:documentation>
  74.                                     </xs:annotation>
  75.                                 </xs:element>
  76.                                 <xs:element name="FileList">
  77.                                     <xs:annotation>
  78.                                         <xs:documentation>A list of all Help 2.0 files that may be installed, refreshed, or reregistered at any point. If you prepend file names with a path spec, the script appends your file path spec to the InstallDest path, creating a list of installation locations. If you do not have compiled index (HXI) files in your set, the script will register only the HXS files, and your topics will not be merged into the BDS index. Note: InstallDest\file list paths and names may also be used to remove files from their installed locations.</xs:documentation>
  79.                                     </xs:annotation>
  80.                                     <xs:complexType>
  81.                                         <xs:sequence>
  82.                                             <xs:element ref="CompiledIndex" minOccurs="0" maxOccurs="unbounded"/>
  83.                                             <xs:element ref="HelpTopic" maxOccurs="unbounded"/>
  84.                                             <xs:element name="TableOfContents" minOccurs="0" maxOccurs="1">
  85.                                                 <xs:annotation>
  86.                                                     <xs:documentation>A table of contents file (*.Hxt) for the associated help topics.</xs:documentation>
  87.                                                 </xs:annotation>
  88.                                                 <xs:simpleType>
  89.                                                     <xs:restriction base="xs:string">
  90.                                                         <xs:pattern value=".+\.[Hh][Xx][Tt]"/>
  91.                                                     </xs:restriction>
  92.                                                 </xs:simpleType>
  93.                                             </xs:element>
  94.                                         </xs:sequence>
  95.                                     </xs:complexType>
  96.                                 </xs:element>
  97.                                 <xs:element ref="Filters" minOccurs="0"/>
  98.                             </xs:sequence>
  99.                         </xs:complexType>
  100.                     </xs:element>
  101.                     <xs:element name="Plugin">
  102.                         <xs:annotation>
  103.                             <xs:documentation>Contains information needed to plug a set of documentation files with the existing Borland documentation set.</xs:documentation>
  104.                         </xs:annotation>
  105.                         <xs:complexType>
  106.                             <xs:sequence>
  107.                                 <xs:element name="Description">
  108.                                     <xs:annotation>
  109.                                         <xs:documentation>Description for the namespace.</xs:documentation>
  110.                                     </xs:annotation>
  111.                                 </xs:element>
  112.                                 <xs:element name="Namespace">
  113.                                     <xs:annotation>
  114.                                         <xs:documentation>The namespace the helpfiles will be included in.</xs:documentation>
  115.                                     </xs:annotation>
  116.                                 </xs:element>
  117.                                 <xs:element name="FileList">
  118.                                     <xs:annotation>
  119.                                         <xs:documentation>A list of all Help 2.0 files that may be installed, refreshed, or reregistered at any point. If you prepend file names with a path spec, the script appends your file path spec to the InstallDest path, creating a list of installation locations. If you do not have compiled index (HXI) files in your set, the script will register only the HXS files, and your topics will not be merged into the BDS index. Note: InstallDest\file list paths and names may also be used to remove files from their installed locations.</xs:documentation>
  120.                                     </xs:annotation>
  121.                                     <xs:complexType>
  122.                                         <xs:sequence>
  123.                                             <xs:element name="Attributes">
  124.                                                 <xs:annotation>
  125.                                                     <xs:documentation>A attributes file (*.Hxa) for the associated help topics.</xs:documentation>
  126.                                                 </xs:annotation>
  127.                                                 <xs:simpleType>
  128.                                                     <xs:restriction base="xs:string">
  129.                                                         <xs:pattern value=".+\.[Hh][Xx][Aa]"/>
  130.                                                     </xs:restriction>
  131.                                                 </xs:simpleType>
  132.                                             </xs:element>
  133.                                             <xs:element name="Collection">
  134.                                                 <xs:annotation>
  135.                                                     <xs:documentation>A collection file (*.Hxc) for the associated help topics.</xs:documentation>
  136.                                                 </xs:annotation>
  137.                                                 <xs:simpleType>
  138.                                                     <xs:restriction base="xs:string">
  139.                                                         <xs:pattern value=".+\.[Hh][Xx][Cc]"/>
  140.                                                     </xs:restriction>
  141.                                                 </xs:simpleType>
  142.                                             </xs:element>
  143.                                             <xs:element ref="CompiledIndex" minOccurs="0" maxOccurs="unbounded"/>
  144.                                             <xs:element name="KeywordIndex" minOccurs="0" maxOccurs="unbounded">
  145.                                                 <xs:annotation>
  146.                                                     <xs:documentation>A keyword index file (*.Hxk) for the associated help topics.</xs:documentation>
  147.                                                 </xs:annotation>
  148.                                                 <xs:simpleType>
  149.                                                     <xs:restriction base="xs:string">
  150.                                                         <xs:pattern value=".+\.[Hh][Xx][Kk]"/>
  151.                                                     </xs:restriction>
  152.                                                 </xs:simpleType>
  153.                                             </xs:element>
  154.                                             <xs:element ref="HelpTopic" maxOccurs="unbounded"/>
  155.                                             <xs:element name="TableOfContents">
  156.                                                 <xs:annotation>
  157.                                                     <xs:documentation>A table of contents file (*.Hxt) for the associated help topics.</xs:documentation>
  158.                                                 </xs:annotation>
  159.                                                 <xs:simpleType>
  160.                                                     <xs:restriction base="xs:string">
  161.                                                         <xs:pattern value=".+\.[Hh][Xx][Tt]"/>
  162.                                                     </xs:restriction>
  163.                                                 </xs:simpleType>
  164.                                             </xs:element>
  165.                                         </xs:sequence>
  166.                                     </xs:complexType>
  167.                                 </xs:element>
  168.                                 <xs:element ref="Filters" minOccurs="0"/>
  169.                             </xs:sequence>
  170.                         </xs:complexType>
  171.                     </xs:element>
  172.                     <xs:element name="Standalone">
  173.                         <xs:annotation>
  174.                             <xs:documentation>Contains information needed to create a new stand-alone help system.</xs:documentation>
  175.                         </xs:annotation>
  176.                         <xs:complexType>
  177.                             <xs:sequence>
  178.                                 <xs:element name="Description">
  179.                                     <xs:annotation>
  180.                                         <xs:documentation>Description for the namespace.</xs:documentation>
  181.                                     </xs:annotation>
  182.                                 </xs:element>
  183.                                 <xs:element name="Namespace">
  184.                                     <xs:annotation>
  185.                                         <xs:documentation>The namespace the helpfiles will be included in.</xs:documentation>
  186.                                     </xs:annotation>
  187.                                 </xs:element>
  188.                                 <xs:element name="FileList">
  189.                                     <xs:annotation>
  190.                                         <xs:documentation>A list of all Help 2.0 files that may be installed, refreshed, or reregistered at any point. If you prepend file names with a path spec, the script appends your file path spec to the InstallDest path, creating a list of installation locations. For stand-alone help systems, you must include both HxI and HxS files.  Note: InstallDest\file list paths and names may also be used to remove files from their installed locations.</xs:documentation>
  191.                                     </xs:annotation>
  192.                                     <xs:complexType>
  193.                                         <xs:sequence>
  194.                                             <xs:element name="Attributes">
  195.                                                 <xs:annotation>
  196.                                                     <xs:documentation>A attributes file (*.Hxa) for the associated help topics.</xs:documentation>
  197.                                                 </xs:annotation>
  198.                                                 <xs:simpleType>
  199.                                                     <xs:restriction base="xs:string">
  200.                                                         <xs:pattern value=".+\.[Hh][Xx][Aa]"/>
  201.                                                     </xs:restriction>
  202.                                                 </xs:simpleType>
  203.                                             </xs:element>
  204.                                             <xs:element name="Collection">
  205.                                                 <xs:annotation>
  206.                                                     <xs:documentation>A collection file (*.Hxc) for the associated help topics.</xs:documentation>
  207.                                                 </xs:annotation>
  208.                                                 <xs:simpleType>
  209.                                                     <xs:restriction base="xs:string">
  210.                                                         <xs:pattern value=".+\.[Hh][Xx][Cc]"/>
  211.                                                     </xs:restriction>
  212.                                                 </xs:simpleType>
  213.                                             </xs:element>
  214.                                             <xs:element ref="CompiledIndex" minOccurs="0" maxOccurs="unbounded"/>
  215.                                             <xs:element name="KeywordIndex" minOccurs="0" maxOccurs="unbounded">
  216.                                                 <xs:annotation>
  217.                                                     <xs:documentation>A keyword index file (*.Hxk) for the associated help topics.</xs:documentation>
  218.                                                 </xs:annotation>
  219.                                                 <xs:simpleType>
  220.                                                     <xs:restriction base="xs:string">
  221.                                                         <xs:pattern value=".+\.[Hh][Xx][Kk]"/>
  222.                                                     </xs:restriction>
  223.                                                 </xs:simpleType>
  224.                                             </xs:element>
  225.                                             <xs:element ref="HelpTopic" maxOccurs="unbounded"/>
  226.                                             <xs:element name="TableOfContents">
  227.                                                 <xs:annotation>
  228.                                                     <xs:documentation>A table of contents file (*.Hxt) for the associated help topics.</xs:documentation>
  229.                                                 </xs:annotation>
  230.                                                 <xs:simpleType>
  231.                                                     <xs:restriction base="xs:string">
  232.                                                         <xs:pattern value=".+\.[Hh][Xx][Tt]"/>
  233.                                                     </xs:restriction>
  234.                                                 </xs:simpleType>
  235.                                             </xs:element>
  236.                                         </xs:sequence>
  237.                                     </xs:complexType>
  238.                                 </xs:element>
  239.                                 <xs:element ref="Filters" minOccurs="0"/>
  240.                             </xs:sequence>
  241.                         </xs:complexType>
  242.                     </xs:element>
  243.                 </xs:choice>
  244.             </xs:sequence>
  245.         </xs:complexType>
  246.     </xs:element>
  247.     <xs:element name="Filters">
  248.         <xs:annotation>
  249.             <xs:documentation>A list of one or more filters. </xs:documentation>
  250.         </xs:annotation>
  251.         <xs:complexType>
  252.             <xs:sequence>
  253.                 <xs:element name="Filter" maxOccurs="unbounded">
  254.                     <xs:annotation>
  255.                         <xs:documentation>A filter for the help system. The specification portion must be in accordance with Help 2.0 authoring conventions. Validation is not performed by the regHelp script, so if the filter is badly formed, it will generate an error message when selected in the reindexed Help system.</xs:documentation>
  256.                     </xs:annotation>
  257.                     <xs:complexType>
  258.                         <xs:simpleContent>
  259.                             <xs:extension base="xs:string">
  260.                                 <xs:attribute name="Name" type="xs:string" use="required"/>
  261.                             </xs:extension>
  262.                         </xs:simpleContent>
  263.                     </xs:complexType>
  264.                 </xs:element>
  265.             </xs:sequence>
  266.         </xs:complexType>
  267.     </xs:element>
  268.     <xs:element name="HelpTopic">
  269.         <xs:annotation>
  270.             <xs:documentation>One or more compiled help topic files (*.Hxs).</xs:documentation>
  271.         </xs:annotation>
  272.         <xs:simpleType>
  273.             <xs:restriction base="xs:string">
  274.                 <xs:pattern value=".+\.[Hh][Xx][Ss]"/>
  275.             </xs:restriction>
  276.         </xs:simpleType>
  277.     </xs:element>
  278.     <xs:element name="CompiledIndex">
  279.         <xs:annotation>
  280.             <xs:documentation>A compiled index file (*.Hxi) for the associated help topics.</xs:documentation>
  281.         </xs:annotation>
  282.         <xs:simpleType>
  283.             <xs:restriction base="xs:string">
  284.                 <xs:pattern value=".+\.[Hh][Xx][Ii]"/>
  285.             </xs:restriction>
  286.         </xs:simpleType>
  287.     </xs:element>
  288. </xs:schema>
  289.